home *** CD-ROM | disk | FTP | other *** search
/ Gigarom 1 / Gigarom Macintosh Archives (Quantum Leap)(CDRM1080320)(1993).iso / FILES / DEV / I-Z / Kermit tool 1.2 GH.cpt / Read Me—Kermit Tool GH < prev    next >
Text File  |  1993-01-17  |  8KB  |  182 lines
  1. Kermit Tool GH version 1.2.0ß1
  2. by  Glenn R. Howes -- University of Wisconsin Department of Chemistry
  3.  
  4. What it is:
  5.  Kermit Tool GH is a freeware file transfer tool for use with  
  6.  programs that utilize the Macintosh Communications Toolbox.
  7.  Commercial and shareware developers must obtain a license to 
  8.  bundle this tool with their products.
  9.  
  10. How to use it:
  11.  1) Get a CTB compliant application. Examples would be ClarisWorks,
  12.  Termy,VersaTerm etc. 
  13.  2) Install the basic CTB set. (this is available from Apple).
  14.  3) Place Kermit Tool GH in either the extensions folder (sys 7) or
  15.  the communications folder (sys 6).
  16.  
  17. What it does:
  18.  Right now, it implements a Kermit file transfer protocal
  19.  with packet size <= 9024 (given enough memory); 1, 2 or 3 byte error 
  20.  checking; attribute packets; run compression; text, and binary or 
  21.  macbinary file transfers.
  22.  In text mode it strips out line feeds while receiving and adds 
  23.  line feeds while transmitting. In macbinary mode it looks for a 
  24.  macbinary header so as to generate a mac-only file (such as an 
  25.  application).
  26.  
  27.  In the future it will support sliding windows, and shift locking. 
  28.  Improvements will also be made in packet generation, cancellation 
  29.  procedure and error recovery, and it will be totally rewritten using 
  30.  the cleaner framework of my YModem tool.
  31.  
  32. Macbinary:
  33.  This tool supports the macbinary file format. If you want to only
  34.  use the current macbinary II format and not decode documents that
  35.  appear to be in macbinary I format you can check the appropriate box
  36.  in the setup dialog.(evidently certain file types such as the gif 
  37.  format can be misinterpreted as macbinary I). If a file being downloaded 
  38.  is determined to not have a valid macbinary header, it will be downloaded 
  39.  as a binary file with the type and creator chosen in the setup dialog. If a
  40.  file with a valid macbinary header is found to be incomplete: the
  41.  length data in the header is longer than the data actually received,
  42.  the file's type will be changed to 'BADD' and its creator to 'KerM',
  43.  with an appropriate icon. This was done to avoid generating
  44.  corrupt files which the finder thinks might be executable, but the
  45.  file will probably be useless anyway. 
  46.  
  47. Performance:
  48.  If you find that running this tool in the background is slowing 
  49.  down your machine too much, reduce the packet length. Alternatively,
  50.  if you want faster transfer speed increase the packet length
  51.  (1024 is a good value if the remote kermit supports it). I think my
  52.  implementation is quick compared to other implementations of Kermit.
  53.  Know that some minimal implementations of Kermit support packet 
  54.  lengths of 94 or less.
  55.  
  56. Tips:
  57.    Make sure that the remote computer is ready for binary files 
  58.  when you transfer binary or macbinary files. Text is usually the
  59.  default.
  60.    If a transfer stops dead, try cancelling and dropping the packet 
  61.  length, I find that a major reason that transfers fail is due
  62.  to problems with packets being too long, especially on sends.
  63.  There is a limit to this, don't drop below 80 byte packets.
  64.    Using run length compression (default) might give a noticeable
  65.  increase in throughput, especially for text files.
  66.    Use 8 bit lines if at all possible, especially for binary files.
  67.    If the remote Kermit doesn't accept a cancel command while sending,
  68.  try hitting Control-A followed by Return. If you do this 10 times 
  69.  in a row you should exceed the remote's retry limit.
  70.    When configuring the remote Kermit, try typing in "help" or "?",
  71.  many implementations will give you info on how to configure things
  72.  like packet-length.
  73.    Auto-receive is a capability supported by some applications which
  74.   will cause this tool's window to automatically pop up in receiving
  75.   mode when a certain string is received. In my case I chose the
  76.   mark character (usually control-A). In general, I would say to
  77.   keep this feature off until I get it implemented better.
  78.    There appears to be some sort of problem found when dealing with
  79.   older Kermits sending files to this tool. Every packet gets
  80.   echoed. I'm working on this, but sometimes waiting until the 
  81.   remote Kermit sends its first packet before starting receiving
  82.   works. (Make sure auto-receive is off).
  83.  
  84. Testing:
  85.  I've had several people beta test this tool, they found several errors
  86.  and made many interface suggestions which I have incorporated into
  87.  this tools design. This does not mean there are no bugs, just that
  88.  I squashed the more obvious ones. 
  89.  
  90. Distribution:
  91.  Feel free to distribute this tool with this Read Me file. However, 
  92.  this tool is not to be sold or bundled with any shareware or 
  93.  commercial software without obtaining a license from me.
  94.  
  95. Legalisms:
  96.  I retain all rights to this tool and to its source code.
  97.  
  98.  I neither give nor imply any warranty of this product. Bugs are
  99.  unavoidable in software development, so any loss of data or
  100.  time caused by this tool is not my responsibility. Besides,
  101.  what did you pay for this tool. :-)
  102.  
  103. Thank You:
  104.   John Scott for rewriting the 'fcsr' segment in his own image
  105.   Brad Spencer and Ed Turner for lending me needed books
  106.   Frank da Cruz for writing "Kermit: A File Transfer Protocol"
  107.   Pete Resnick and John Rawnsley for their extra help in beta.
  108.   Symantec for selling a beautiful C compiler (Think C 5.0)
  109.   My mother for having me and 9 other children.
  110.  
  111. In the unlikely event you care:
  112.   My birthday is May 19th, and my favorite presents are cash,
  113.   shrink wrapped software and expensive computer equipment.
  114. -------------------------------------------------------------------
  115. If you find a serious bug, please catalog:
  116. how they occured,
  117. what equipment (computer),
  118. system software,
  119. application software,
  120. communication setup (parity, data bits, speed....),
  121. anything else that appears appropriate,
  122. your e-mail address if you have one
  123.  
  124. Glenn Howes
  125. Room #3211
  126. 1101 University Ave. 
  127. Madison,WI 53706
  128. howes@bert.chem.wisc.edu
  129. -------------------------------------------------------------------
  130. version history:
  131. initial release 1.0
  132. version 1.1 
  133.  • added balloon help to setup dialog
  134.  • allowed the disabling of run length compression
  135.  • broke background sends into chunks for multifinder friendliness
  136.  • added support for multi-file sends
  137.  • fixed crc block checking (18-bit)
  138.  • added a preferences file
  139.  • fixed bug that prevented receiving macbinary files in bulk
  140.  • changed the icon (to see remove previous versions and 
  141.    rebuild the desktop-->hold command-option down during 
  142.    startup)
  143.  • added "bad macbinary" file type icon
  144.  • various cosmetic changes to both setup and status windows
  145.  • fixed bug in in macbinary encoding
  146. version 1.1.1
  147.  • fixed another bug in generating macbinary
  148.  • fixed bug in file compression algorithm
  149.  • added force 8th bit prefixing option 
  150.  • added CTB auto-receive functionality for applications that use it.
  151.    this is still in the experimental stage, so keep this off if 
  152.    possible.
  153.  • the odd cosmetic and human interface change.
  154. version 1.1.2
  155.  • improved cancellation procedure
  156.  • made multi-file receives more compatible with what applications
  157.      expect.
  158.  • fixed the odd bug here and there.
  159.  • reduced the memory requirements for a give packet length
  160.  • no longer sucks up the first few bytes the remote sends at the
  161.    end of a transfer (for Bill Lippa).
  162.  • added x of y to status field
  163. version 1.2
  164.  • made the status window as big and beautiful as that of my
  165.    YModem tool.
  166.  • moved x of y to filename field
  167.  • made the determination if an incoming file is macbinary much
  168.    earlier in the transfer
  169.  • No longer opens a dummy file for macbinary transfers. This was
  170.    evidently causing problems for some people
  171.  • No longer leaves the status window hanging around invisible between
  172.    transfers. Evidently, this could cause a crash in MacTerminal.
  173.  • No longer leaves the various transfer buffers allocated between
  174.    transfers, this should make some application's programmers happy.
  175.  • Should now handle dealing with certain misbegotten implementations
  176.    of Kermit that actually put a character higher than ~ into the
  177.    length byte of a classic packet. You know who you are.
  178.  • Now test for parity problems by examining the negotiation packet.
  179.    This should improve the chances of a transfer being successful
  180.  • Added a ".bin" extension to macbinary send files
  181.  • Added an attribute packet for when sending files, so the remote
  182.    computer has some idea of the size and type.